package com.luo.demo.validation.constraints;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.*;

/**
 * 枚举范围 - 验证注解
 *
 * @author luohq
 * @date 2023-06-16
 */
@Documented
@Constraint(validatedBy = EnumRangeValidator.class)
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
public @interface EnumRange {
    /**
     * 枚举类型
     */
    Class<? extends Enum> enumType();

    /**
     * 枚举值的方法名（默认name，即对应枚举名称）
     */
    String enumValueMethod() default "name";

    /**
     * 验证失败时的提示信息
     */
    String message() default "值不在枚举范围内";

    /**
     * 验证分组
     */
    Class<?>[] groups() default {};

    /**
     * 验证负载
     */
    Class<? extends Payload>[] payload() default {};

}